Skip to content

Fix SS06 formatting errors #29255

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Oct 29, 2019
Merged

Fix SS06 formatting errors #29255

merged 7 commits into from
Oct 29, 2019

Conversation

profwacko
Copy link
Contributor

SS06 (Summary should fit in a single line) errors fixed (#29254) for the following:

 pandas.DataFrame.slice_shift
 pandas.DataFrame.to_period
 pandas.DataFrame.plot
 pandas.DataFrame.sparse.density
 pandas.DataFrame.style
 pandas.Series.as_blocks
 pandas.Series.ix
 pandas.Series.ptp
 pandas.DataFrame.as_blocks
 pandas.DataFrame.ix

Validated with python scripts/validate_docstrings.py

Also referencing issue: #27977

SS06 errors fixed for the following:

 pandas.DataFrame.slice_shift
 pandas.DataFrame.to_period
 pandas.DataFrame.plot
 pandas.DataFrame.sparse.density
 pandas.DataFrame.style
 pandas.Series.as_blocks
 pandas.Series.ix
 pandas.Series.ptp
 pandas.DataFrame.as_blocks
 pandas.DataFrame.ix
@profwacko profwacko changed the title Fix SS06 errors Fix SS06 formatting errors Oct 28, 2019
@WillAyd WillAyd added the Docs label Oct 28, 2019
@WillAyd WillAyd added this to the 1.0 milestone Oct 28, 2019
Copy link
Member

@WillAyd WillAyd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Minor comments to improve styling / remove repetition

represented in the DataFrame.
Ratio of non-sparse points to total (dense) data points.

Ratio of non-sparse points to total (dense) data points represented
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you can remove this extended summary; it says the same thing as the first line


.. deprecated:: 0.21.0

Convert the frame to a dict of dtype-> Constructor Types that each
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove this as well; just duplicative

building a styled HTML representation fo the DataFrame.
Returns a Styler object.

Property returning a Styler object containing methods for building
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like the word of is misspelled here

@profwacko
Copy link
Contributor Author

Hi @WillAyd, added the changes you suggested.

@profwacko profwacko requested a review from WillAyd October 29, 2019 01:35
@WillAyd WillAyd merged commit 90166c9 into pandas-dev:master Oct 29, 2019
@WillAyd
Copy link
Member

WillAyd commented Oct 29, 2019

Great thanks @profwacko !

@profwacko profwacko deleted the fix-docstring-format branch October 30, 2019 16:17
Reksbril pushed a commit to Reksbril/pandas that referenced this pull request Nov 18, 2019
proost pushed a commit to proost/pandas that referenced this pull request Dec 19, 2019
proost pushed a commit to proost/pandas that referenced this pull request Dec 19, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants